docs: add polished README for PyO3 + Polars + Conda project purpose - #16
Merged
Merged
Conversation
Updated the input and output tables in the README to include transaction dates and clarified the challenge description.
Clarify explanations and improve examples in README.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
README.mdthat explains the repository purpose: writing Rust functions exposed to Python via PyO3 to accelerate complex Polars DataFrame processing and prepare the project for Conda distribution.Description
README.mdthat outlines the repository purpose, core approach (Polars+Rust+PyO3), and Conda packaging intent.Testing
nl -ba README.md, which printed the full draft successfully.git status --shortandgit rev-parse --short HEAD, and created a commit viagit add README.md && git commit -m "docs: add polished README describing project purpose and use case", all of which succeeded.Codex Task